package com.sky.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

/**
 * Swagger配置类
 */
@Configuration

public class SwaggerConfiguration {

  /**
   * 创建API应用
   * apiInfo()：添加API相关信息
   * select()：返回一个ApiSelectorBuilder实例，用来控制哪些接口暴露给Swagger来展现
   * apis()：指定扫描的包路径
   * paths()：指定路径处理PathSelectors.any()代表所有的路径
   */
  @Bean
  public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()
        .apis(RequestHandlerSelectors.basePackage("com.sky.controller"))
        .paths(PathSelectors.any())
        .build();
  }

  /**
   * 创建该API的基本信息（这些基本信息会展现在文档页面中）
   * 访问地址：http://项目实际地址/doc.html
   */
  private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
        .title("苍穹外卖API文档")
        .description("苍穹外卖系统接口文档，包含管理端和用户端接口")
        .version("1.0")
        .build();
  }
}